MarkLogic 12 Product Documentation
GET /manage/v2/databases/{id|name}/cpf-configs/{domain-id-or-default-domain-name}/properties

Summary

This resource address returns the CPF configuration properties for the specified domain.

URL Parameters
format	The format of the returned data. Can be either `json` or `xml` (default). This value overrides the Accept header if both are present.

Request Headers
Accept	The expected MIME type of the response. If the `format` parameter is present, it takes precedence over the Accept header.
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response Headers
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

domain-name

restart-user-name

eval-module

eval-root

conversion-enabled

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.